SGPanelGetSettings(IM: QC)

Inside Macintosh: QuickTime Components /

Chapter 7 - Sequence Grabber Panel Components / Sequence Grabber Panel Components Reference

Functions / Managing Your Panel's Settings

SGPanelGetSettings
Sequence grabber components call your component's SGPanelGetSettings function in order to retrieve your panel's current settings.
pascal ComponentResult SGPanelGetSettings 
                                 (SeqGrabPanelComponent s,
                                  SGChannel c, UserData *ud, 
                                  long flags);
s
Identifies the sequence grabber component's connection to your panel component.
c
Identifies a connection to the sequence grabber channel associated with your panel component.
ud
Contains a pointer to a user data item. Your component is responsible for creating a new user data item and returning that item by means of this pointer. Your component is not responsible for disposing of the user data item.
flags
Reserved for future use.

DESCRIPTION
A sequence grabber component calls your SGPanelGetSettings function in order to obtain a copy of your panel's current settings. The sequence grabber stores these settings for you and may use them to restore your panel's settings by calling your SGPanelSetSettings function (described next). Your component should store whatever values are necessary to properly configure your associated channel component. For example, Apple's video compression panel component saves such values as video compressor component type, compression quality, key frame rate, and frame rate values.
These settings may be stored as part of a larger sequence grabber configuration and may be stored for a long period of time. Therefore, you should not store values that may change without your knowledge (such as component ID or connection values).
You are free to format the data in the user data item in any way you desire. Make
sure you can retrieve the settings information from the user data item when your SGPanelGetSettings function is called. You may choose to format the data in such a way that other components can parse it easily, thus allowing your component to operate with other panel components.
You create a new user data item by calling the Movie Toolbox's NewUserData function (see the chapter "Movie Toolbox" in Inside Macintosh: QuickTime for more information about this function). You may then use other Movie Toolbox functions to manipulate the user data item.

SEE ALSO
Sequence grabber components use your component's SGPanelSetSettings function to restore this configuration information. That function is discussed next.